Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Setting up tests #10

Merged
merged 14 commits into from
Jun 12, 2024
Merged

Setting up tests #10

merged 14 commits into from
Jun 12, 2024

Conversation

kamaroly
Copy link
Collaborator

@kamaroly kamaroly commented Jun 11, 2024 •
edited by sourcery-ai bot
Loading

Goal
Making it easier for the developer to do TDD while adding feature to salad UI or fixing bugs.

Changelist

  1. Added Github workflow to automatic run tests when a PR is sent to master, main, staging and dev branch.
  2. Added mix test.watch to make it easier for TDD.
  3. Added necessary dependencies for testing in the mix.exs
  4. Added the ComponentCase test helper, for the unit tests.
  5. Added SaladUI.AlertTest test for the alert component tests.
  6. And more code format improvements

Summary by Sourcery

This pull request sets up the testing infrastructure for the project. It introduces mix test.watch for TDD, adds necessary dependencies and aliases in mix.exs, and includes a GitHub workflow for running tests on specific branches. Additionally, it adds a ComponentCase test helper and a test suite for the alert component. The README.md has been updated with instructions for running tests and formatting code.

  • New Features:
    • Introduced mix test.watch for easier Test-Driven Development (TDD).
    • Added ComponentCase test helper for unit tests.
    • Added SaladUI.AlertTest for alert component tests.
  • Enhancements:
    • Formatted code in multiple files for consistency and readability.
  • Build:
    • Updated mix.exs to include necessary dependencies for testing and added aliases for common tasks.
  • CI:
    • Added GitHub workflow to automatically run tests on PRs to master, main, staging, and dev branches.
  • Documentation:
    • Updated README.md to include instructions for running tests and formatting code before sending a pull request.
  • Tests:
    • Removed placeholder test in salad_ui_test.exs.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jun 11, 2024

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@sourcery-ai Sourcery AI
Copy link

sourcery-ai bot commented Jun 11, 2024 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request sets up the testing environment for the Salad UI project. It includes the addition of a GitHub workflow for automated testing, new dependencies for testing, a test helper module, and initial test cases for the Alert component. Additionally, it includes code formatting improvements across several files.

File-Level Changes

Files Changes
lib/salad_ui/table.ex
lib/salad_ui/dialog.ex
lib/salad_ui/dropdown_menu.ex
lib/salad_ui/separator.ex		 Formatted attribute and slot definitions for better readability.
test/salad_ui/alert_test.exs
test/support/component_case.ex		 Added initial test cases and test helper module for component testing.
Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

sourcery-ai[bot]
sourcery-ai bot reviewed Jun 11, 2024
View reviewed changes
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @kamaroly - I've reviewed your changes and found some issues that need to be addressed.

Blocking issues:

  • Hard-coded secret found in GitHub Actions workflow. (link)
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🔴 Security: 1 blocking issue
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

.github/workflows/salad_ui.yml Outdated Show resolved Hide resolved
bluzky
bluzky reviewed Jun 11, 2024
View reviewed changes
.github/workflows/salad_ui.yml Outdated Show resolved Hide resolved
.vscode/settings.json Outdated Show resolved Hide resolved
mix.exs Outdated Show resolved Hide resolved
mix.exs Outdated Show resolved Hide resolved
bluzky
bluzky reviewed Jun 12, 2024
View reviewed changes
mix.exs Show resolved Hide resolved
mix.exs Show resolved Hide resolved
@bluzky bluzky merged commit dfa21d5 into setup-dev Jun 12, 2024
2 checks passed
@bluzky bluzky deleted the setting-up-tests branch June 12, 2024 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@kamaro-amitruck kamaro-amitruck kamaro-amitruck left review comments

@bluzky bluzky bluzky approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@kamaroly @bluzky @kamaro-amitruck